Skip to content

Document Splunk HEC metadata and raw endpoint support#278

Open
mavam wants to merge 2 commits intomainfrom
topic/to-splunk-improvements
Open

Document Splunk HEC metadata and raw endpoint support#278
mavam wants to merge 2 commits intomainfrom
topic/to-splunk-improvements

Conversation

@mavam
Copy link
Copy Markdown
Member

@mavam mavam commented Apr 24, 2026

🔍 Problem

  • The to_splunk reference did not cover the new HEC metadata options or raw endpoint mode from the code PR.
  • Users needed examples for setting Splunk _time, indexed HEC fields, and raw event ingestion.
  • The documented raw-mode UX needed to match the final raw=... API instead of the earlier endpoint-selector draft.

🛠️ Solution

  • Update the to_splunk signature and option descriptions for event, raw, time, and fields.
  • Document that event envelopes are the default, event=... selects the envelope payload, and raw=<string> selects raw HEC mode.
  • Document that event=... and raw=... are mutually exclusive.
  • Document raw request-level metadata, metadata-based raw flushes, and that fields is not supported with raw=....
  • Add examples for event time, indexed fields, and raw event ingestion.

💬 Review

🛠️ Code PR: tenzir/tenzir#6074
🧩 Plugin PR: tenzir/tenzir-plugins#520
🎫 References TNZ-517, TNZ-518, TNZ-519

Update the to_splunk reference with the neo event metadata options, raw endpoint behavior, and examples for time, fields, and raw events.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 24, 2026

📦 Preview  ·  View →  ·  🟢 Live

Verified for d7d51ec  ·  Auto-updates on push

Update the to_splunk reference to describe raw HEC mode through the mutually exclusive raw expression instead of the removed endpoint option.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

reference Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant